IntelliJ Platform Gradle Plugin/org.jetbrains.intellij.platform.gradle.tasks/PrepareSandboxTask

PrepareSandboxTask

@CacheableTask

abstract class PrepareSandboxTask : Sync, SandboxProducerAware

Prepares a sandbox environment with the installed plugin and its dependencies. The sandbox directory is required by tasks that run IDE and tests in isolation from other instances, like when multiple IntelliJ Platforms are used for testing with RunIdeTask, TestIdeTask, TestIdeUiTask, or TestIdePerformanceTask tasks.

To fully use the sandbox capabilities in a task, make it extend the SandboxAware interface.

See also

IntelliJPlatformExtension.sandboxContainer

Constants.Sandbox

Constructors

PrepareSandboxTask

constructor()

Types

object Companion : Registrable

Properties

conventionMapping

@get:Internal

val conventionMapping: ConventionMapping

defaultDestinationDirectory

@get:Internal

abstract val defaultDestinationDirectory: DirectoryProperty

Default sandbox destination directory to where the plugin files will be copied into.

@get:Internal

var enabled: Boolean

hasCustomActions

val hasCustomActions: Boolean

impliesSubProjects

var impliesSubProjects: Boolean

intelliJPlatformConfiguration

@get:InputFiles

@get:PathSensitive(value = PathSensitivity.RELATIVE)

abstract val intelliJPlatformConfiguration: ConfigurableFileCollection

Holds the Configurations.INTELLIJ_PLATFORM configuration with the IntelliJ Platform dependency added. It should not be directly accessed.

@get:Internal

open val platformPath: Path

Provides access to the IntelliJ Platform dependency artifact path.

@get:InputFile

@get:PathSensitive(value = PathSensitivity.RELATIVE)

abstract val pluginJar: RegularFileProperty

The output of Jar task. The proper Jar.archiveFile is picked depending on if code instrumentation is enabled.

pluginsClasspath

@get:Classpath

abstract val pluginsClasspath: ConfigurableFileCollection

List of dependencies on external plugins resolved from the Configurations.INTELLIJ_PLATFORM_PLUGINS_EXTRACTED configuration.

@get:Internal

open val productInfo: ProductInfo

Provides information about the IntelliJ Platform product. The information is retrieved from the product-info.json file in the IntelliJ Platform directory.

runtimeClasspath

@get:Classpath

abstract val runtimeClasspath: ConfigurableFileCollection

Dependencies defined with the JavaPlugin.RUNTIME_CLASSPATH_CONFIGURATION_NAME configuration.

sandboxConfigDirectory

@get:Internal

abstract val sandboxConfigDirectory: DirectoryProperty

A configuration directory located within the sandboxContainerDirectory.

sandboxContainerDirectory

@get:Internal

abstract val sandboxContainerDirectory: DirectoryProperty

The container for all sandbox-related directories. The directory name depends on the platform type and version currently used for running a task.

sandboxLogDirectory

@get:Internal

abstract val sandboxLogDirectory: DirectoryProperty

A log directory located within the sandboxContainerDirectory.

sandboxPluginsDirectory

@get:Internal

abstract val sandboxPluginsDirectory: DirectoryProperty

A plugins directory located within the sandboxContainerDirectory.

@get:Internal

abstract val sandboxSuffix: Property<String>

Represents the suffix used i.e., for test-related tasks.

sandboxSystemDirectory

@get:Internal

abstract val sandboxSystemDirectory: DirectoryProperty

A system directory located within the sandboxContainerDirectory.

val state: TaskStateInternal

val timeout: Property<Duration>

Functions

acceptServiceReferences

open override fun acceptServiceReferences(serviceReferences: MutableSet<ServiceReferenceSpec>)

appendParallelSafeAction

open override fun appendParallelSafeAction(action: Action<in Task>)

open operator override fun compareTo(other: Task): Int

open override fun configure(closure: Closure<*>): Task

conventionMapping

open fun conventionMapping(property: String, mapping: Closure<Any>): Task

open fun conventionMapping(property: String, mapping: Callable<*>): Task

open override fun dependsOn(vararg paths: Any): Task

open override fun dirPermissions(configureAction: Action<in ConfigurableFilePermissions>): CopyProcessingSpec

open override fun doFirst(action: Closure<Any>): Task

open override fun doFirst(action: Action<in Task>): Task

open override fun doFirst(actionName: String, action: Action<in Task>): Task

open override fun doLast(action: Closure<Any>): Task

open override fun doLast(action: Action<in Task>): Task

open override fun doLast(actionName: String, action: Action<in Task>): Task

doNotTrackState

open override fun doNotTrackState(reasonNotToTrackState: String)

open override fun eachFile(closure: Closure<Any>): AbstractCopyTask

open override fun eachFile(action: Action<in FileCopyDetails>): AbstractCopyTask

fun ensureName(path: Path): String

open override fun exclude(excludeSpec: Closure<Any>): AbstractCopyTask

open override fun exclude(vararg excludes: String): AbstractCopyTask

open override fun exclude(excludes: MutableIterable<String>): AbstractCopyTask

open override fun exclude(excludeSpec: Spec<FileTreeElement>): AbstractCopyTask

open override fun expand(properties: MutableMap<String, *>): AbstractCopyTask

open override fun expand(properties: MutableMap<String, *>, action: Action<in ExpandDetails>): AbstractCopyTask

filePermissions

open override fun filePermissions(configureAction: Action<in ConfigurableFilePermissions>): CopyProcessingSpec

open override fun filesMatching(pattern: String, action: Action<in FileCopyDetails>): AbstractCopyTask

open override fun filesMatching(patterns: MutableIterable<String>, action: Action<in FileCopyDetails>): AbstractCopyTask

filesNotMatching

open override fun filesNotMatching(pattern: String, action: Action<in FileCopyDetails>): AbstractCopyTask

open override fun filesNotMatching(patterns: MutableIterable<String>, action: Action<in FileCopyDetails>): AbstractCopyTask

open override fun filter(closure: Closure<Any>): AbstractCopyTask

open override fun filter(filterType: Class<out FilterReader>): AbstractCopyTask

open override fun filter(transformer: Transformer<String, String>): AbstractCopyTask

open override fun filter(properties: MutableMap<String, *>, filterType: Class<out FilterReader>): AbstractCopyTask

open override fun finalizedBy(vararg paths: Any): Task

open override fun from(vararg sourcePaths: Any): AbstractCopyTask

open override fun from(sourcePath: Any, c: Closure<Any>): AbstractCopyTask

open override fun from(sourcePath: Any, configureAction: Action<in CopySpec>): AbstractCopyTask

open override fun getActions(): MutableList<Action<in Task>>

open override fun getAnt(): AntBuilder

getAsDynamicObject

@Internal

open override fun getAsDynamicObject(): DynamicObject

@Internal

open override fun ~~getConvention~~(): Convention

open override fun getDependsOn(): MutableSet<Any>

open override fun getDescription(): String?

getDestinationDir

open override fun getDestinationDir(): File

getDestroyables

open override fun getDestroyables(): TaskDestroyables

open override fun getDidWork(): Boolean

@Internal

open override fun getDirMode(): Int?

getDirPermissions

@Internal

open override fun getDirPermissions(): Property<ConfigurableFilePermissions>

getDuplicatesStrategy

@Internal

open override fun getDuplicatesStrategy(): DuplicatesStrategy

@Internal

open override fun getExcludes(): MutableSet<String>

open override fun getExtensions(): ExtensionContainer

@Internal

open override fun getFileMode(): Int?

getFilePermissions

@Internal

open override fun getFilePermissions(): Property<ConfigurableFilePermissions>

getFilteringCharset

@Internal

open override fun getFilteringCharset(): String

open override fun getFinalizedBy(): TaskDependency

open override fun getGroup(): String?

getIdentityPath

open override fun getIdentityPath(): Path

getIncludeEmptyDirs

@Internal

open override fun getIncludeEmptyDirs(): Boolean

@Internal

open override fun getIncludes(): MutableSet<String>

open override fun getInputs(): TaskInputsInternal

getLifecycleDependencies

@Internal

open override fun getLifecycleDependencies(): TaskDependencyInternal

open override fun getLocalState(): TaskLocalState

open override fun getLogger(): Logger

open override fun getLogging(): LoggingManager

getMustRunAfter

open override fun getMustRunAfter(): TaskDependency

open override fun getName(): String

open override fun getOnlyIf(): Spec<in TaskInternal>

open override fun getOutputs(): TaskOutputsInternal

open override fun getPath(): String

@Internal

open fun getPreserve(): PatternFilterable

open override fun getProject(): Project

getReasonNotToTrackState

open override fun getReasonNotToTrackState(): Optional<String>

getReasonTaskIsIncompatibleWithConfigurationCache

open override fun getReasonTaskIsIncompatibleWithConfigurationCache(): Optional<String>

getRequiredServices

open override fun getRequiredServices(): TaskRequiredServices

open override fun getRootSpec(): DestinationRootCopySpec

getSharedResources

open override fun getSharedResources(): MutableList<ResourceLock>

getShouldRunAfter

open override fun getShouldRunAfter(): TaskDependency

@Internal

open fun getSource(): FileCollection

getStandardOutputCapture

open override fun getStandardOutputCapture(): StandardOutputCapture

open override fun getTaskActions(): MutableList<InputChangesAwareTaskAction>

getTaskDependencies

open override fun getTaskDependencies(): TaskDependencyInternal

getTaskIdentity

open override fun getTaskIdentity(): TaskIdentity<*>

getTemporaryDir

open override fun getTemporaryDir(): File

getTemporaryDirFactory

open override fun getTemporaryDirFactory(): Factory<File>

open override fun hasProperty(propertyName: String): Boolean

open override fun hasTaskActions(): Boolean

open override fun include(includeSpec: Closure<Any>): AbstractCopyTask

open override fun include(vararg includes: String): AbstractCopyTask

open override fun include(includes: MutableIterable<String>): AbstractCopyTask

open override fun include(includeSpec: Spec<FileTreeElement>): AbstractCopyTask

open override fun into(destDir: Any): AbstractCopyTask

open override fun into(destPath: Any, configureClosure: Closure<Any>): AbstractCopyTask

open override fun into(destPath: Any, copySpec: Action<in CopySpec>): CopySpec

fun intoChild(destinationDir: Any): CopySpec

isCaseSensitive

@Internal

open override fun isCaseSensitive(): Boolean

isCompatibleWithConfigurationCache

open override fun isCompatibleWithConfigurationCache(): Boolean

open override fun mustRunAfter(vararg paths: Any): Task

notCompatibleWithConfigurationCache

open override fun notCompatibleWithConfigurationCache(reason: String)

open override fun onlyIf(onlyIfClosure: Closure<Any>)

open override fun onlyIf(spec: Spec<in Task>)

open override fun onlyIf(onlyIfReason: String, spec: Spec<in Task>)

prependParallelSafeAction

open override fun prependParallelSafeAction(action: Action<in Task>)

open fun preserve(action: Action<in PatternFilterable>): Sync

open override fun property(propertyName: String): Any?

open override fun rename(closure: Closure<Any>): AbstractCopyTask

open override fun rename(renamer: Transformer<String, String>): AbstractCopyTask

open override fun rename(sourceRegEx: Pattern, replaceWith: String): AbstractCopyTask

open override fun rename(sourceRegEx: String, replaceWith: String): AbstractCopyTask

open override fun setActions(replacements: MutableList<Action<in Task>>)

setCaseSensitive

open override fun setCaseSensitive(caseSensitive: Boolean)

open override fun setDependsOn(dependsOn: MutableIterable<*>)

open override fun setDescription(description: String?)

setDestinationDir

open fun setDestinationDir(destinationDir: File)

open override fun setDidWork(didWork: Boolean)

open override fun setDirMode(@Nullable mode: Int?): AbstractCopyTask

setDuplicatesStrategy

open override fun setDuplicatesStrategy(strategy: DuplicatesStrategy)

open override fun setExcludes(excludes: MutableIterable<String>): AbstractCopyTask

open override fun setFileMode(@Nullable mode: Int?): AbstractCopyTask

setFilteringCharset

open override fun setFilteringCharset(charset: String)

open override fun setFinalizedBy(finalizedByTasks: MutableIterable<*>)

open override fun setGroup(group: String?)

setIncludeEmptyDirs

open override fun setIncludeEmptyDirs(includeEmptyDirs: Boolean)

open override fun setIncludes(includes: MutableIterable<String>): AbstractCopyTask

setMustRunAfter

open override fun setMustRunAfter(mustRunAfterTasks: MutableIterable<*>)

open override fun setOnlyIf(onlyIfClosure: Closure<Any>)

open override fun setOnlyIf(spec: Spec<in Task>)

open override fun setOnlyIf(onlyIfReason: String, spec: Spec<in Task>)

open override fun setProperty(name: String, value: Any)

setShouldRunAfter

open override fun setShouldRunAfter(shouldRunAfterTasks: MutableIterable<*>)

open override fun shouldRunAfter(vararg paths: Any): TaskDependency

open override fun usesService(service: Provider<out BuildService<*>>)

validateIntelliJPlatformVersion

open fun validateIntelliJPlatformVersion()

Validates that the resolved IntelliJ Platform is supported by checking against the minimal supported IntelliJ Platform version.

open override fun with(vararg sourceSpecs: CopySpec): CopySpec